Gigarom 1/Gigarom Macintosh Archives (Quantum Leap)(CDRM1080320)(1993).iso/FILES/APP/E-L/Histog.cpt/Histog.ƒ/Histog Help

Text File | 1991-06-09 | 29KB | 468 lines

                                  -HISTOG VERSION 2.11 INSTRUCTIONS-

     This program plots histograms of data, which you input from the keyboard, into
bins.  Any axis of the histogram can be either according to the value of the data or
to a percentage of the total data.  Up to 200 bins are permitted incorporating up to
7500 data points (memory permitting). The data and the various plot options can be
saved onto a disk file.  Histograms are very useful for getting a “fingerprint” of
some data and comparing that with the “fingerprint” of some other data.  Histog
produces a tidy histogram graph and data listing.

     If a Histog File is named “Histog StartUp” and is placed in the same folder as
Histog, it will be used as the default settings for Histog.  Everything will be copied
including data, notes, plot limits and font settings.  This allows you to customize
Histog to your own preferences.

     Both the data and/or the histogram can be printed on any type of printer
including the Imagewriter, any laser printer and the HP Deskwriter.  The data or
histogram may also be copied to the Clipboard.  Geneva is the default font for
Histog unless another font has been selected.  Histog supports the Adobe Type
Manager and automatically sets fractional widths.

     During data entry, duplicate values may be entered as “n*a” where “a” is the
data value and “n” is the number of times to duplicate it.  All duplicates are tacked
on following the first data item after you click “Accept”.  Also during numerical
data entry, any text appended to a data value is ignored permitting you to “tag”
your data.  This applies throughout this program.

     The “Normal Plot” options superimpose a choice of bell or half-bell distribution
curves over the histogram plot.  Each axis of the histogram plot may either be an
absolute data value or a percentage.  Use “Set Plot Limits…” to select this option
as well as set all other graph limits and tic spacing.  Use “Set Plot Options…” to
very shade and width of this plot.

--------------------------MENU SELECTIONS DEFINED-------------------------
                                                          -FILE-
•New:  Begin a new data base.  If you have previously had another data base up on
Histog, you will be asked whether you wish to keep the previous “Set Plot
Limits…” or to default to Histog's settings. This feature is useful if you are going
to have numerous data bases which will all have the same plot limits.  Keeping
previous plot limits also keeps previous “Font” and “Normal Plot” selections.
Either way, “New” opens up the data entry window with the cursor position at the
top.  If you also wish to keep the previous “Note…” and “Set Plot Options…”, then
select the “All” button.

Data may be a number value (123, etc.) or a string (ABC, etc.).  However, all
strings take a numerical value of zero (0) unless they are preceded by a numerical
value as described in the next paragraph.  Numerical values cannot exceed ±1E+35
or be non-zero smaller than ±1E-35 or they will default to zero (0).

Over range values will be replaced by an “ERR” and Histog will present an error
dialog after pressing the “Accept” button.  Under range values display their keyin
value but are interpreted as zero (0).  Since histograms rarely employ exponential
numbers of these magnitudes, this should present no problem or limitation at all.

Numerical data may be entered in any one of four formats:

  1.  Keyin data such as:        25.4             1.23E12         -0.129
  2.  Keyin data with tags:     6.3 inches     12 miles         19.6 oz
  3.  Keyin multiple data:       8*25.4         4*7.0 yards

The data tags (inches, etc.) are ignored if they follow the data entry.  Keep at least
one space between data and data tag and Histog will preserve the data tag through
any conversion operation.  Don't use spaces in your data since everything after the
space will be taken as a data tag giving you some interesting results.

If any tag or text precedes the data (or replaces it) the entry will be taken as zero
(0).  Multiple data mode (e.g. 4*7.0 yards) always places the first entry and all
multiples of that data where the cursor was.  All this occurs only after you choose
“Accept”.  Note that for multiple entry the following are equivalent: 8*25.4, 8 *
24.5 and 8* 25.4 feet.  In each case 24.5 will be entered 8 times. Where the data
tag “feet” was appended to the data, that too would be replicated.  If you get cute
and keyin something such as Dog*Cat, Dog will be interpreted as zero (0) and,
since it is a multiplier, will default to one (1) and you will end up with Cat (sans
Dog).

Caution:  Do not use “*” except for multiplication and then only once.  The data
entry 5*3*8 will be interpreted by Histog as 5 times “3*8” the first time you
click “Accept”.  If you should “Add” any data to your list, the next time you click
“Accept”, Histog will process the 5 “3*8” lines and you will end up with a total
of 15 “8's”.    Histog always replaces bad multiplier values with one (1) and bad
data values with “ERR”.

•Open:  Opens a data base from a floppy or hard disk.  Any un-saved data base
which is currently up will prompt a warning that it is not saved.  When you first
launch Histog, if you hold down the “Command” key, you will automatically bring
up the “Open” dialog instead of the “New” data window.

Any data file which is damaged or incomplete will load with a warning that the File
Identifiers do not match and that the file may be damaged.  However, Histog does
attempt to load as much as possible but you take your chances and the file will be
treated as an “Untitled” file.

If a file is too big for Histog (a large file written by Histog on a Mac with 1MB but
now being read by Histog on a small Mac 512KE or with limited MultiFinder
menory), an error dialog will come up warning about overflow.  All of the data that
could be read will be OK but the file will be treated as an “Untitled” file to prevent
you from accidentally doing a “Save” over the original data.  When you do a “Save
As”, the new file will, naturally, be smaller than the original.
.............................................................................................................................
•Merge Data:  Speedy way of taking data from one file and adding it to the data
which is currently loaded.  All data merged will be added to the end of the current
data list.  Histog will “Beep” if your merge data causes the data base to exceed the
Histog limit.  The “Plot Limits” and current “Font” are not affected.

•Merge Plot Limit:  Copies all scale plot limits and font options from a selected file
and updates the current data base accordingly.  The data base itself is not affected.
Neither of the merge options affects the status of the information “Note…” field or
or the previous “Set Plot Options…” settings.
.............................................................................................................................
•Save:  Save a previously saved data base when the data has been updated.  Will do
nothing if the data has been saved and not since changed.  If the data has never been
saved before, selecting “Save” will actually call “Save As…”.  If you are
inputting data and wish to save what you have already entered, press the
“Accept” button to exit that window, then select “Save”.  You can then re-enter
the data window by selecting “Add Data” from the “SetUp” menu.

•Save As…:  Save any new data for the first time.  You must exit the “New” data
window first, however, by pressing “Accept” in order to do this.  Attempts to
save data onto full disks or into already open files, etc. will be answered with a
disk file warning message.  No data is lost when this happens.  You must merely
find another disk with enough room on it.  Histog files are very compact and a great
many of them will fit on a single disk.
.............................................................................................................................
•Print Histogram:  Prints the histogram graph.  The plot is automatically sized and
centered.  Histog supports the Imagewriter, Laserwriter and the HP Deskwriter.
Whatever font is currently selected will be the printer font used.  When selected,
you will be presented with the “Page Setup” dialog box followed by the “Print
Dialog” box.  Select whatever page orientation and print resolution you desire.

•Print Data:  Prints a summary of the histogram data such as average, standard
deviation, etc. followed by all the data printed in rows of five.  Any “tag”
information is retained.  Whatever font is currently selected will be the printer
font used.

•Fast Print All:  Prints both the histogram and the data in a single stroke without
calling the “Page Setup” or “Print Dialog”.  The printout defaults to “Vertical”
and “Better” quality format and has been provided as an option where lots of data
is being reviewed.  If, while in the Finder, several Histog documents are selected
and the menu option “Print” is selected, all of those files will be printed in the
“Fast Print All” format.  Up to 32 files at a time can be printed in this way.

•Histogram to Clipboard:  Transfers the graph to the Clipboard as an object
drawing sized to about 4" by 6".  This picture may be then pasted into a word
processor such as Word™ or into a drawing program such as MacDraw™, etc.
where it may be resized or modified further.  Whatever font is currently selected
will be the Clipboard font used.

•Data to Clipboard:  Transfers just the data to the Clipboard (but not the summary)
to facilitate transfer to other applications.  This function is not intended to transfer
bulk data from one Histog data file to another.  Use the “Merge Date” function for
that.  Whatever font is currently selected will be the Clipboard font used.
.............................................................................................................................
•Delete…:  Deletes the selected Histog file.  No other file but a Histog data file can
be deleted with this command.  If you delete a file that is already loaded into
Histog, Histog will keep the data from that file but will revert the file name to an
“Untitled” name and the original file name will disappear from the menu.

•Rename…:  Renames the selected Histog file.  Again, only Histog data files can be
renamed.  If you rename a file that is already loaded into Histog, Histog will accept
the new name and even the name in the menu bar will change to reflect the new
name.

•Transfer…:  Provided as a convenience.  Allows you to jump directly to another
program without entering the Finder.  Any un-saved data will prompt a warning.

•Quit:  Exits Histog.  If any data has been changed, you will get an alert which
gives you the opportunity to either “Save” the data or “Save As” the data as
another file name.  The “Cancel” returns you back to Histog.

                                                        -EDIT-
•Undo:  Not required by Histog but provided for use by any desk accessory you
may wish to run while Histog is running.  Histog accomplishes the “Undo” function
by allowing you the opportunity to “Cancel” or “Accept” any input secession.

•Cut:  Use to cut a section of text or data.  Supports all desk accessories and the
edit fields within Histog.  You cannot “Cut” a graph to the Clipboard. There is a
separate command provided to do that.

•Copy:  Same as cut but does not eliminate the original.  While in the data window,
you may select and copy a single cell of data and paste it into another cell.

•Paste:  Enters contents of the Clipboard at cursor insertion point.  Graphics
cannot, obviously, be pasted into Histog.  You may, however, use the “Data to
Clipboard” command to copy data into another applications data file.

•Clear:  Clears selected text or data.  Primarily supports desk accessories but
does have functionality when either inputting data or plot limits.


                                                       -SETUP-
•Add Data…:  Opens the data entry window and places the cursor at the end of the
data list in preparation for adding data.  Select “Cancel” and all added data will be
ignored.  Otherwise, select “Accept”.  Selecting “Add” when there is no data to
add to will merely invoke an empty data list with the cursor at the top.  Entering
data values greater than ±1E+35 or using out-of-range multipliers will also invoke
an error dialog warning after you select “Accept”.  Histog will always replace bad
multiplier values with one (1) and bad data values with “ERR”.

•Set Plot Limits…:  Used to define the histogram graph limits.  Upon selection, you
will be presented with a “Histogram Options” window with the following
selections:

  1.  Title of Histogram:  appears at top of printout sheet.  Do not enter anymore
       text than will fit in the box or you may lose some in the printout.
  2.  Number of Bins (200 max):  Typical values are 20.  Too many bins makes
       your histogram too busy unless you have a very large data base.
  3.  X-Axis Title:  Describe the limits and units of the limits.
  4.  Value or Percent:  “V” or “Value” treats the X-axis as data and displays it
       accordingly.  “P” or “Percent” or “%” treats the X-axis as a percentage
       of the total data span.  This is useful when you are more interested in the
       “finger print” of the histogram.  For example, with the X-axis set for 0 to
       100 (%), all data bins are automatically always included.
  5.  X-axis min/max.  Use numerical values when in the “Value” mode and
       percent values (like 0 and 100) when in “Percent” mode.
  6.  Big Tic/Small Tic spacing.  Defines the placement of the X-axis tics.  For
       example: with a min of 0 and a max of 100, 25 for big tic would place 4 big
       tics spaced every 25 apart.  Also, 5 for small tic would place 20 small tics
       spaces with 5 per main division (5 small tics per big tic).  Got it?
  7.  The remainder apply to the Y-axis for which the above on the X-axis apply.
       It is common to plot the Y-axis in percent, usually 0 to 50.  Use “Cancel”
       to revert to previous settings and “Accept” to keep the data.  Use the
       “Help” button for keyboard shortcuts which apply only to this window.

Note: If you desire more than one line of text in the X-Axis or Y-Axis title, use the
vertical slash “|” as a deliminator for each line.  This is especially of use for the
left hand Y-Axis scale where you do not have much room.  For example if you input
the title “Percent|Of|Total” you will see each word display on its own line
(“Percent” over “Of” over “Total”).  The only illegal character is the quote
symbol (") which will automatically be replaced by the curly quote (”).

•Set Plot Options…:  Use to alter histogram plot graph presentation.  Histog default
has no vertical or horizontal grid lines, the histogram bars are 25% grey with
black outline and the optional normal plot is 50% grey, 2 pixels wide.  When you
select this you will be presented with a series of dialog boxes which permits you to
vary several options:
  1.  Horizontal grid lines…several combinations of grey, black or none.
  2.  Vertical grid lines…same as above.
  3.  Histogram bar fill…transparent, white, black, grey, cross hatch, etc.
  4.  Bar outline…similar to above but pertains to just the bar line perimeter.
  5.  Normal plot…various shades (not clear or white).  Use 50% grey with Laser
       printers for very nice effect.  Cross hatch gives dotted appearance.
  6.  Normal plot line width…normally 1 or 2 but any size up to 32 pixels is OK.

These options are saved with each file but do not affect Histog default settings.  If
you have a favorite set of plot options,  plot limits, default note, etc., save a
dummy file with these conditions preset and name it “Histog StartUp”.  Place this
file into the same folder as Histog.  This file will automatically open when you
launch Histog.  Save this startup file with a single data entry to make as small a
file (282 bytes) as possible.  (Due to the way Histog manages disk files, zero data
entries will default to a full matrix null file of about 28K bytes which will slow
your startup time a bit but otherwise cause no harm.)

•Note…:  Opens an information text window which permits the addition of a more
detailed description of your data file.  This information text will then become the
header of the “Print Data” printout and of the “Show Statistics” window.  Use
this feature whenever you cannot put enough detailed information in your “Plot
Limits” titles.  The “Note…” window will accept “Returns” for multiple line
entries.  It will, alternately, accept the “|” symbol and convert it to “Returns”.
As with “Plot Limits…”, the only illegal character here is the quote symbol (")
which will automatically be replaced by the curly quote (”).
.............................................................................................................................

 •Add Constant…:  Allows you to add a numerical constant to all of the data in the
data base.  For example: if you enter -1.5 to the prompt you get, the constant 1.5
will be subtracted from every data item.  Any alpha string is always interpreted as
zero (0).  You cannot use zero (0) as the constant.

Note:   All data tags are preserved provided they are separated from the data by at
least one space.  Do not use spaces in the data itself.  This applies for the next four
(4) “data bending” functions as well.

•Multiply Constant…:  Will multiply every data item by the negative or positive
constant you keyin.  Will not accept zero (0) since that will null out your entire
data base to zero (0).  All data tags are deleted since the data is being modified and
the tag would no longer be valid.

•Power Constant…: Raises every data item to the power of this constant.  Negative
values invert the data as well.  For example, -1 will just invert the data while -2
will square the data and invert it.  Will not accept zero (0) since that will convert
your entire data base to one (1).  All data tags are deleted since the data is being
modified and the tag would no longer be valid.

•Round Off…: Rounds off all of the data in the Histog data base according to the
round off value chosen.  The value must always be an integer (decimal portion of
any value is truncated) and may be positive, zero, or negative.  (Any string text is
normally interpreted as zero.)  If zero, the data is converted to an integer.

If a negative value is chosen, the data will set the number of decimal places to that
value.  (For example, if value = -2, 1.23456 becomes 1.23 but 12345.6 is
unchanged.)

If a positive value is chosen, the data will set the number of significant figures to
that value.  (For example, if value = 3, 12345.6 becomes 12300, 1.23456E+12
becomes 1.23E+12, 1.2345 becomes 1.23 while 12.3 remains unchanged.

If you type the word “Absolute”, Histog will, instead, take the absolute value of
all the data in the data base.  All negative values will be positive and all positive
values will be unchanged.

If you type in the word “Strip Tags”, Histog will strip all data tags from the data
base.  Data values will be unchanged.

You will always get a warning that there is no way to undo the “round off”,
“absolute” or ”strip tags” operations.  Always save your data before using this
function.  Unless you are stripping, all data tags are preserved provided they are
separated from the data by at least one space.

•Filter…: Eliminates everything in the data base above or below the filter value.
For example if the Hi-Pass button is pressed and the filter value is zero (0), every
value in the data base less than zero is erased permanently.  The Lo-Pass function
works just the opposite.  Always save your data before using this function.  All
data tags are preserved provided they are separated from the data by at least one
space.

The preceding five data modifying functions are provided as a convenience where
data must be modified for specific “What if?” reporting.  Its greatest use,
however, is where the recorded data is in error somehow and needs to be fixed.
You can keep one file with the original data and one file with the corrections or the
spurious readings filtered out.
.............................................................................................................................
•Exclude Normal Plot:  Cancels the following three normal plot options.  This is the
default mode for when Histog starts up initially.  All “Normal Plot” options,
however, are saved with the disk file and are remembered when the file is
re-opened.

•Center Normal Plot:  This superimposes a standard bell curve over the histogram
plot.  The upper and lower limit of the curve match the ±3-sigma points.  The height
of the curve is related to the data peak.  The curve helps you compare your data to
a normal distribution.  Obviously, if your distribution is not normal, you may get a
curve that doesn't seem to fit at all.  Wild swings in data points or very high values
usually guarantee that normal plots will not be of much use other that they prove to
you that you don't have a normal plot.  When selected, the normal curve is included
in the Clipboard copy, the print copy or the screen copy of the histogram.

•Left Normal Plot:  This superimposes a half standard bell curve over the
histogram plot.  The lower limit of the curve matches the 3-sigma point.  The
height of the curve is related to the data peak.  The curve helps you compare your
data to a half bell normal distribution.  The half bell normal distribution is
encountered when the data represents something that is equal to or less than a
perfect value.  Obviously you can't get better than perfect so the distribution is
always a half bell.  When selected, the left normal curve is included in the Clipboard
copy, the print copy or the screen copy of the histogram.

•Right Normal Plot:  This is just like the Left Normal Plot except the plot skews to
the right side.  Choose which curve fits your data best.  Any normal selection made
is included with the disk file when the data is saved.  The shade and width of this
plot can be changed using “Set Plot Options…”.
.............................................................................................................................
•Show Histogram:  Displays the histogram full size on the screen.  Automatically
fills the screen no matter what size screen you are using.  When the graph is
displayed, the cursor turns into cross hairs anywhere in the graph.  Just click at
any point and the X and Y values are displayed at the bottom of the picture for
accurate resolution of any data.  This display will show the values of scales 1
through 4. Scale 1 is the y-axis and scale 2 is the x-axis.  Scales 3 and 4 are
duplicates of 1 and 2.  Press any key or the “go-away” box to exit the graph
display.

•Show Statistics:  Displays statistics pertaining to the currently entered data.
This is the same statistics header that tops the printed data output.  Included is:
  1.  Number of data entries, Average (arithmetic mean), Standard Deviation.
  2.  Half Standard Deviation, 2-Standard Deviation and 3-Standard Deviation.
  3.  Lowest value, Highest value, Range (highest-lowest).
  4.  Number of bins, Lowest bin, Highest bin.
  5.  Number within bin limits, number below lowest and above highest bin value.
  6.  Geometric Mean, Quadratic Mean and Harmonic Mean.
.............................................................................................................................
•Help:  Opens up the help window which, obviously, you have already found.  If
Histog cannot find the help file, you will be presented with a dialog box which will
allow you to search for it.  Histog will remember the location until you quit.  Keep
the “Histog Help” file in the same folder as Histog and do not try to re-name it.

The optional “Open...” button permits opening additional help windows which can be
made from text files which have had their creator set to “HSTA” and their type
changed from “TEXT” to “HSTH”.  Of course, if you choose to make these
additional Help files you will have to set the window width to 5.0 inches and use
Geneva 9 point and a carriage return at the end of each line to match the current
Help window.  No word wrap is done to speed opening the file.

Holding down the option key, however, while clicking “Open...” will permit Histog
to open any “TEXT” file by any creator (MS Word, MacWrite, etc.) for reading of
any notes you may wish to make.  When this feature is used, Histog now will
automatically word wrap the text files so you don't need to worry about line length
when you create the file.  Files requiring automatic word wrap take a few extra
seconds longer to open so that is why the “HSTH” files don't do it.

Also in the “Help” function there is text search capability.  Click “Find...” and you
will be presented with a dialog box into which you can place the search text.  When
found, the line with the search text will appear at the top of the scroll window.
Click “Next” to find the next occurance of the search text.  When no further
occurances can be found, Histog will “Beep” and the “Next” button will be
dimmed.  Since every menu command is listed in this document with a bullet
(option-8) in front of it (•), you can quickly jump to instructions on any menu item
by including the bullet.  For example; “•Open” as the search string would jump to
the instructions about Opening a file.  Partial words are also legal.


                                                         -FONT-
•Font selection is possible for the Histogram and the Data output.  All graph and
data which is output to the printer, screen or Clipboard will be in the font selected
in this menu.  Due to menu limitations, only the first 20 available fonts can be
currently listed in this “Fonts” menu.  This font selection is saved with the data
file.  Histog is compatible with all Adobe Type Manager outline fonts and is
automatically set for fractional widths. Currently, only FONT ID's from 0 to 511
are searched for.  This includes all FONT ID's from 0 to 255 and NFNT FONT ID's
from 256 to 511.  NFNT font types which use higher ID numbers will not be listed.
In general, this should not present any problem.


                                                      “FileName”
•When Histog has a disk file open, the name of that file will appear in the menu bar
directly to the right of the “Fonts” menu.  This is provided as a convenience only
and cannot be selected to do anything except to show the file pathname (DiskName,
FolderName, etc) and the file date and time tag.  Selecting either of these items will
result only in a beep.  When no disk file is open this area is blank.

---------------------------------------------------------------------------
Compatibility with other applications:  Histog has been tested with Grappler™,
SuperLaserSpool™, MasterJuggler™, SteppingOut™, ATM™, MultiDisk™,
DiskExpress™ II, Boomerang, In Use, SuperClock, MultiFinder and just about every
desk accessory and FKEY imagineable without any trouble.  Histog is aware of
background screen size changes (SteppingOut™ and the Radius Pivot™).  Print
spoolers do tend to slow down Histog's responsiveness a little so, when using a
print spooler, try selecting “Pause” in the spooler and print your files later.
Otherwise, don't type too fast while spooling.  Remember that you can print up to
32 files from the Finder if you need to do batch printing.

MultiFinder operation requires a size setting of at least 1032k to use the full data
base of 7500 entries.  If memory is limited and you still need to operate under
MultiFinder, you may use a size setting of 800k for 5000 entries, 568k for 2500
entries, 429k for 1000 entries, and as little as 382K for 500 entries.  Smaller
size settings than 382k are not permitted.  In between memory settings other than
noted are ignored.

Note:  Operation on a older Mac 512KE will not permit the full number of data
entries. Depending upon the size of System and RAM cache you are using, the Mac
512K will be allowed either 500 or 1000 data entries maximum.  Histog will not
function on a Mac 512K (old ROM) or a Mac 128K model.  Histog performs just fine
on Mac II and Mac SE-30 machines.  Histog can be made available specifically
compiled for newer Mac II and/or FFP (fast floating point) operation for much
higher speed operation, however, such speed increases should hardly be necessary.


Histog was written and developed on Microsoft QuickBASIC 1.0 using QuickMODULE,
which is a special program development package written by and available from...

                                                 Raymond DiBugnara
                                                   18 Meadow Road
                                            Bolton, Massachusetts 01740.